Skip to main content

平台 UI 教程

本教程将引导您使用平台 UI 在 Zapier 上构建一个集成，包括认证、触发器和操作。

先决条件​

  • 您需要一个 Zapier 帐户。

  • 如果您以前未使用过 Zapier，请先通过我们的 Zapier 入门指南 学习基础知识。

  • 熟悉 API。

  • 选择一个带有公开文档的 API，无论是您自己的应用 API，还是您作为用户熟悉的某个应用。

1. 开始构建集成​

要添加一个集成：

  • 访问 https://developer.zapier.com/。

  • 登录您的 Zapier 帐户。

  • 点击 启动 Zapier 集成。

  • 接下来，您将被要求提供集成相关的信息：

    • 名称：添加您集成的名称。
    • 描述：添加一个不超过 140 字符的应用描述。
    • 主页 URL：添加您应用的主页 URL。该域将用作电子邮件域，允许团队成员作为协作者加入您的集成。
    • 徽标：上传一个正方形、透明的 PNG 图像作为您的应用徽标。图像尺寸至少为 256x256 像素，且不包含应用名称。请参阅 品牌指南 以了解更多信息。
    • 目标受众：从下拉菜单中选择您正在构建的集成是公共集成还是私有集成。
    • 角色：从下拉菜单中选择您与要与 Zapier 集成的应用的关系。
    • 类别：从下拉菜单中选择您应用的分类方式。

  • 完成添加集成详细信息后，点击 创建。

2. 添加认证​

认证 定义了 Zapier 平台如何与您要连接的应用 API 进行认证，包括收集和存储用户数据以允许访问其帐户。Zapier 支持以下认证方案：

  • API 密钥
  • 基本认证
  • Digest 认证
  • OAuth v2
  • 会话

请参考您要构建集成的应用 API 文档，选择适合您 API 的认证方案。为用户连接其应用帐户到 Zapier 时显示的输入表单添加认证字段。

按照您选择的认证方案的每个配置步骤进行操作，添加相关的端点用作授权 URL，以交换用户提供的凭证进行认证。根据您的 API 认证方法，您可能还需要在应用开发者设置中配置 Zapier 提供的应用凭证。

3. 添加触发器​

触发器 允许用户在应用中添加或更新内容时启动 Zapier 工作流。

添加触发器的显示设置、任何可选输入字段，并在 API 配置选项卡中连接应用 API。

如果您要使用的 API 支持 REST Hooks，则可以配置触发器，以便为每个 Zap 创建一个唯一的订阅，从而实现近实时运行，并在应用中发生事件时将事件发送到 Zapier。

或者，配置一个轮询触发器，该触发器会自动每 1 到 15 分钟轮询您提供的 URL 以获取新数据，具体取决于用户的 Zapier 计划。合适的轮询端点应按逆时间顺序返回结果，以确保新项或更新项出现在结果的第一页。轮询端点通常使用 GET 请求。

默认的 表单模式 允许您添加 API 端点 URL、选择 API 调用类型，并包含任何认证细节和输入表单数据与 API 调用。

可选的切换到 代码模式 会将 API 请求表单中的所有内容转换为 JavaScript 代码，这是一个高级功能，本教程不涉及。

4. 添加操作​

操作 允许用户通过您的 API 在应用中创建、搜索或更新记录。一般来说，不推荐在集成中使用删除操作。

添加操作的显示设置、至少一个输入字段，并在 API 配置选项卡中连接应用 API。

请参考您应用的 API 文档，选择一个常用记录及其可用端点，并添加一个创建操作，该操作在测试时会在您的应用中添加记录。创建新记录通常使用 POST 请求。

5. 测试您的集成​

在构建集成时，在平台 UI 中测试认证、触发器和操作的功能非常重要，同时也在 Zap 编辑器 中进行测试。在 Zap 编辑器 中，您将看到集成用户如何使用您的触发器和操作创建 Zap。

了解更多关于 测试您的集成 的信息。

6. （可选）验证您的集成​

运行自动化检查 以识别错误并获取改进集成用户体验的建议。

这些检查仅在您构建公共集成时需要通过，但它们对于任何集成识别未来更新的建议也非常有用。

7. （可选）邀请团队成员​

集成不是由个人拥有，而是由团队拥有。您可以在平台 UI 中邀请团队成员作为管理员或协作者进行协作。

了解更多关于 向您的集成添加团队成员 的信息。

8. （可选）分享您的集成​

一旦您至少有一个触发器或操作，您可能希望与某些用户分享您的集成。及早获取反馈有助于确保您正在构建将被使用的功能。

您可以通过公共链接或电子邮件与用户分享您的集成。

注意：公共集成 可以被任何 Zapier 用户访问，且不需要特别邀请用户。

9. 修改您的集成​

如果您需要对集成进行任何更改，可以通过创建新版本 来实现。版本有助于跟踪和管理集成随时间的变化。

公共集成或拥有超过 5 个用户的私有集成必须通过新版本进行编辑。即使是拥有少于 5 个用户的私有集成，我们也建议在考虑 Zapier 的最佳实践时，通过新版本进行更改。

了解更多​

需要帮助？告诉我们您的问题，我们会将您连接到合适的资源或支持团队。